GET Attachments?assetId={assetId}&includeContent={includeContent}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}
Retrieves attachments for the given parameters. All parameters are optional.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
assetId |
Id of the asset |
globally unique identifier |
None. |
includeContent |
Include the file contents of the attachments |
boolean |
Default value is False |
take |
Number of attachments to retrieve. Default is all attachments |
integer |
None. |
skip |
Number of attachments to skip before retrieval |
integer |
Default value is 0 |
sort |
List of sorting rules to describe how to sort the attachments before retrieval |
Collection of Sort |
None. |
Operator | string |
None. |
|
Field | string |
None. |
|
Value | string |
None. |
|
Logic | string |
None. |
|
Filters | Collection of Filter |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of attachments.
Name | Description | Type | Additional information |
---|---|---|---|
Data | Collection of Attachment |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": [ { "AttachmentId": "6a8b83f7-98cb-4689-a855-510cdf4be855", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "2a25be29-15a0-4e49-8797-880fb3ae96c6", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "12c3fc65-2f79-4577-8548-cb076da9b99b", "CreateDate": "2024-05-01T16:51:22.5084014-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-05-01T16:51:22.5084014-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "b462f8c6-1230-4446-adf1-93e710c67970", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "32b70ea4-e231-432e-880f-5c6d7a6bb72a", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "231604ce-7d92-42a2-8e81-e309312a07ba", "CreateDate": "2024-05-01T16:51:22.5084014-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-01T16:51:22.5084014-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "d419fa8d-cea5-4ce2-960d-6fb4dd525b9b", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-01T16:51:22.5084014-07:00", "MeasurementValueNeededDate": "2024-05-01T16:51:22.5084014-07:00", "SourceSystemId": "sample string 3", "CompanyId": "5efbe07f-c4fa-4d8b-b320-9358688f470a", "CreateDate": "2024-05-01T16:51:22.5084014-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-01T16:51:22.5084014-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-05-01T16:51:22.5084014-07:00", "MeasurementValueNeededDate": "2024-05-01T16:51:22.5084014-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "3d750478-157d-4ede-95c9-81ca5252fa3a", "CreateDate": "2024-05-01T16:51:22.5084014-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-01T16:51:22.5084014-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2024-05-01T16:51:22.5084014-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "b0631db4-654d-424d-a742-30317b7b6b4a", "CreateDate": "2024-05-01T16:51:22.5084014-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-01T16:51:22.5084014-07:00", "LastModifiedUser": "sample string 7" }, { "AttachmentId": "6a8b83f7-98cb-4689-a855-510cdf4be855", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "2a25be29-15a0-4e49-8797-880fb3ae96c6", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "12c3fc65-2f79-4577-8548-cb076da9b99b", "CreateDate": "2024-05-01T16:51:22.5084014-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-05-01T16:51:22.5084014-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "b462f8c6-1230-4446-adf1-93e710c67970", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "32b70ea4-e231-432e-880f-5c6d7a6bb72a", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "231604ce-7d92-42a2-8e81-e309312a07ba", "CreateDate": "2024-05-01T16:51:22.5084014-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-01T16:51:22.5084014-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "d419fa8d-cea5-4ce2-960d-6fb4dd525b9b", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-01T16:51:22.5084014-07:00", "MeasurementValueNeededDate": "2024-05-01T16:51:22.5084014-07:00", "SourceSystemId": "sample string 3", "CompanyId": "5efbe07f-c4fa-4d8b-b320-9358688f470a", "CreateDate": "2024-05-01T16:51:22.5084014-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-01T16:51:22.5084014-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-05-01T16:51:22.5084014-07:00", "MeasurementValueNeededDate": "2024-05-01T16:51:22.5084014-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "3d750478-157d-4ede-95c9-81ca5252fa3a", "CreateDate": "2024-05-01T16:51:22.5084014-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-01T16:51:22.5084014-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2024-05-01T16:51:22.5084014-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "b0631db4-654d-424d-a742-30317b7b6b4a", "CreateDate": "2024-05-01T16:51:22.5084014-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-01T16:51:22.5084014-07:00", "LastModifiedUser": "sample string 7" } ], "Total": 1, "Message": "sample string 1" }